Parámetros

Los parámetros proporcionan un método para pasar datos a una solicitud de API al agregar dinámicamente un valor cuando se llama a una API desde dentro de un proceso. Pueden utilizarse en URL base, rutas de URL de acción, encabezados, cuerpos de solicitud y, cuando se exponen a procesos, están disponibles como entradas para acciones en objetos y procesos cuando se selecciona el servicio de API adecuado como objeto de negocio.

Se pueden configurar dos tipos de parámetros en una definición de API, parámetros comunes y parámetros específicos de la acción. Los parámetros comunes se utilizan en todas las acciones y los parámetros configurados a nivel de acción solo están disponibles para esa acción.

Para utilizar un valor de parámetro en rutas de URL, encabezados y cuerpos de solicitud, encierre los parámetros entre corchetes. Por ejemplo:

http://staff.database.com/api/[version]/employee/[id]

Cuando se ejecuta un proceso que utiliza la definición de API asociada y se expanden los parámetros, la URL podría convertirse en lo siguiente:

http://staff.database.com/api/v2/employee/290054

Para usar corchetes sin hacer referencia a un parámetro, el texto debe comenzar con corchetes dobles. Por ejemplo, si el cuerpo de la solicitud incluyó lo siguiente:

{

"favourite-colours": [["green", "red", "blue"]

}

Cuando se llama a la API, la solicitud HTTP incluye los corchetes:

{

"favourite-colours": ["green", "red", "blue"]

}

Los parámetros se aplican en el punto en el que se llama a una API y los valores se toman de la definición de API si se ha establecido un valor inicial. Sin embargo, si se expuso el parámetro y se ha ingresado un valor como una entrada en una acción de proceso, se utilizará este valor.

En el siguiente ejemplo, se configuran dos parámetros comunes en la definición de API, ambos con valores iniciales establecidos y expuestos a procesos.

Se hace referencia a los parámetros en la URL de solicitud.

Un valor de entrada para el parámetro de versión se establece en una acción, pero no para el parámetro de ID.

Cuando se ejecuta la acción y se llama a la API, el valor del parámetro de la versión se toma de la definición de la API y la ID de la entrada de acción.